Inside Macintosh: QuickDraw GX Graphics /

Chapter 3 - Geometric Styles / Geometric Styles Reference

Functions / Getting and Setting Dashes

GXGetShapeDashPositions

You can use the GXGetShapeDashPositions function to determine the precise locations where QuickDraw GX draws a particular shape's dashes.

long GXGetShapeDashPositions(gxShape source, 
                             gxMapping dashMappings[]);

source

A reference to the shape whose dash positions you want to find.

dashMappings

An array of dash positions. On return, this array contains mappings that indicate the position of the dashes of the source shape.

function result

The number of dash positions returned in the dashMappings parameter.

DESCRIPTION

The GXGetShapeDashPositions function returns in the dashMappings parameter mappings that indicate the locations and rotations of the dashes as drawn along the contours of the source shape.

The function result is the number of dash positions returned--the number of dash shapes drawn along the contours of the source shape.

If you pass nil for the dashMappings parameter, the GXGetShapeDashPositions function still returns as the function result the number of dashes but it does not return the positions of the dashes.

This function returns 0 if the source shape is not dashed.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
shape_is_nil
Warnings
graphic_type_cannot_be_dashed

SEE ALSO

For a discussion of dashes, see "Dashes" on page 3-27.

For an example of using this function, see "Determining Dash Positions" on page 3-81.

For a discussion of the gxDashRecord structure, see "The Dash Structure" on page 3-103.

To retrieve dash information from a style object, use the GXGetStyleDash function, which is described on page 3-135. To specify dash information for a style object, use the GXSetStyleDash function, which is described on page 3-136.

To retrieve dash information from a style object associated with a particular shape, use the GXGetShapeDash function, which is described on page 3-138. To specify dash information for a style object associated with a particular shape, use the GXSetShapeDash function, which is described on page 3-139.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help